Improve documentation about default JsonReader
and JsonWriter
behavior
#2341
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
Tries to improve the documentation about default
JsonReader
andJsonWriter
behavior, and relatedTypeAdapter
methodsDescription
The current default behavior was not explicitly mentioned; also for the
TypeAdapter
methods it was not clear that their behavior differs from the defaultGson
behavior, see also #1133.Also removes some empty lines at the start of
<pre>
blocks in the documentation (they also appeared in the rendered HTML).Checklist
null
@since $next-version$
(
$next-version$
is a special placeholder which is automatically replaced during release)TestCase
)mvn clean verify javadoc:jar
passes without errors